home *** CD-ROM | disk | FTP | other *** search
/ MacWorld UK 2000 March / MW_UK_2000_03.iso / Shareware World / Utilities / Text Processing / Alpha / Help / VOODOO Help < prev   
Encoding:
Text File  |  1998-05-07  |  10.5 KB  |  260 lines  |  [TEXT/ALFA]
  1. ###################################################################
  2.  AlphaVOODOO - integrates Alpha with VOODOO
  3.  
  4.                                    created: 6/30/97 {11:13:46 PM} 
  5.                                last update: 5/6/98 {8:49:00 PM} 
  6.                                    version: 1.0.0b7
  7.  Author: Jonathan Guyer
  8.  E-mail: <jguyer@his.com> 
  9.     WWW: <http://www.his.com/~jguyer/>
  10.  
  11. ###################################################################
  12.  
  13. Copyright (C) 1998  Jonathan Guyer
  14.  
  15. This package is free software; you can redistribute it and/or modify
  16. it under the terms of the GNU General Public License.
  17.  
  18. ###################################################################
  19.  
  20. IMPORTANT: This version of AlphaVOODOO only functions with Alpha v7, 
  21. including those versions available from:
  22.  
  23.     <http://www.santafe.edu/~vince/pub/Alpha/>
  24.  
  25. ###################################################################
  26.  
  27. This package integrates the Alpha text editor
  28.  
  29.     <http://www.cs.umd.edu/~keleher/alpha.html>
  30.  
  31. with the VOODOO (Versions Of Outdated Documents Organized 
  32. Orthogonally) version management package:
  33.  
  34.     <http://www.unisoft.co.at/products/voodoo.html>
  35.     
  36.     
  37.     
  38.            Usage
  39.  
  40.             Projects
  41.           
  42. Select the “VOODOO:Connect:Choose…” menu item to assign a VOODOO 
  43. project.  Once selected, a settings dialog will be provided for the 
  44. project before connecting to it.  The project name, for Alpha's 
  45. purposes, is a near approximation of its actual name, with curly 
  46. brackets removed and a number appended in the event of name 
  47. conflicts.  The name can be changed by selecting 
  48. “VOODOO:Connect:Rename…”.  Each new project is added to the 
  49. “VOODOO:Connect” submenu for easy reconnection.
  50.  
  51. Currently, selection of a new project automatically disconnects 
  52. the old one.  This is done, in part, because that's what the 
  53. BBEdit extension does.  If you would like more than one project 
  54. to remain connected for some reason, let me know.  The active 
  55. project is also disconnected when you quit Alpha.  Let me know 
  56. if this is a problem.
  57.           
  58. NOTE: Because of limitations in Alpha's AppleEvent interface, 
  59. VOODOO will not be brought forward if there is anything wrong 
  60. with your user name or password.  You'll get an alert (e.g., 
  61. blinking icon in the menu bar) and you can manually shift to 
  62. VOODOO, but it won't happen automatically.
  63.  
  64. There currently is no mechanism for creating VOODOO projects 
  65. through AppleEvents, so you will need to create your project in 
  66. VOODOO, but you can then use Alpha to define what files should be 
  67. in the project (such as adding all open windows or all files of 
  68. an Alpha fileset).  There is not currently a straight-forward way 
  69. to determine what files are already in a project, such that an 
  70. Alpha fileset could be created from an existing VOODOO project.  
  71. I know of a cumbersome way to do it, so if it's important to you, 
  72. let me know and I'll see what I can do.
  73.  
  74.             Settings
  75.  
  76.               Variants
  77.         
  78. You may restrict the VOODOO variants which are visible by either 
  79. typing the variant names in explicitly or by clicking the 
  80. “Variants…” button in the “VOODOO:Settings…” dialog.  As long as 
  81. the project is logged on, a list of available variants will be 
  82. provided, allowing you to select or <shift>-select the variant(s) 
  83. you are interested in.  If the project is not logged on, the most 
  84. recently available list will be provided, along with a warning 
  85. that it is not current.
  86.  
  87. You may, if you get your jollies that way, type in the variant 
  88. names.  Enclose each variant name in squirrely brackets, e.g.,
  89.  
  90. {Variant 1} {Variant 2} {Variant 3}
  91.           
  92.             Customizing actions
  93.  
  94. Hold down the <option> key in the VOODOO menu to use VOODOO's 
  95. dialog to make adjustments to Fetch, Store, and Add requests 
  96. before completing them.
  97.  
  98.             File comparison
  99.           
  100. In order to compare files with archived files, you need VOODOO 
  101. version 1.8.1b6 or greater; AlphaVOODOO knows this and will not 
  102. request comparisons from earlier versions.
  103.  
  104.             Key bindings
  105.  
  106. To the curious: <command><shift><control> was selected as having 
  107. no (known) conflicts with other modes, thereby allowing all 
  108. VOODOO commands to have the same bindings.
  109.  
  110.            Acknowlegements
  111.         
  112. My thanks to Christoph Reichenberger for writing VOODOO in the 
  113. first place, and for providing extensive help on this package in 
  114. the second.
  115.  
  116. I'm indebted to Pete Keleher for having provided an editor worth 
  117. connecting to and to Vince Darley for making it much easier to 
  118. write packages.
  119.  
  120. I've borrowed liberally and shamelessly from Vince Darley's 
  121. “Vince's Additions”.  Thanks Vince!
  122.  
  123.            To do
  124.         
  125.     • AlphaVOODOO doesn't activate automatically after installation. 
  126.       Manual activation works properly.
  127.     • Converter for old-style project data is needed.
  128.  
  129.            Recent Changes
  130.  
  131. ###################################################################
  132. 1.0.0b7     May 6, 1998
  133. ###################################################################
  134.  
  135.     • Code reorganization.
  136.     • Vince's updated menu tools used.
  137.     • Updated aebuild/aeparse/aecoerce suite used for more automated 
  138.       handling of AppleEvents.
  139.     • cmd argument removed from voodoo::eligibleFiles.  upvar used 
  140.       now.
  141.     • voodoo::try more flexible and makes use of updated try command.
  142.     • voodoo::*userName moved to aebuild.tcl
  143.     • Overly clever upvar mechanism for changing projects eliminated.  
  144.       Master projects are now ordinally numbered, 
  145.       voodoo::projects::[0-9]+, and are swapped in and out of 
  146.       voodooProjects.
  147.     • Incremental numbers on projects changed from "<nn>" to "[nn]" 
  148.       for better menu compatibility.
  149.     • Minimum version of VOODOO for compares is 1.8.1.  Earlier betas 
  150.       worked too, but they have expired now.
  151.  
  152. ###################################################################
  153. 1.0.0b6     March 1, 1998
  154. ###################################################################
  155.  
  156.     • AlphaVOODOO is a better citizen now, providing an uninstall 
  157.       script and cleaning up messes left by earlier installers.
  158.     • Error catching and handling mechanism now much more general.
  159.     • In the event that none of the selected files are eligible for 
  160.       VOODOO, e.g., shells, Diff reports, etc, an alert is now 
  161.       posted. Before, nothing happened at all.
  162.     • Instead of setting the default project owner's name to 
  163.       InternetConfig's user name, which virtually never gave the 
  164.       correct result, AlphaVOODOO now obtains the Mac's owner 
  165.       name under MacOS 8.x and makes a pretty good guess under MacOS 
  166.       7.x (by using the owner of the Preference folder; almost 
  167.       certain to be the Mac's owner).
  168.     • Old "appleEvents.tcl" calls replaced with new "aebuild.tcl" calls.
  169.     • Various minor bug fixes.
  170.     • VOODOO's new «event CompComp» is _not_ supported, due to lack 
  171.       of capability in Alpha's AppleEvent interface. 
  172.       'compareExternalFiles' renamed to 'voodoo::compareFiles'.
  173.     • Better integration with diffMode.tcl (requiring changes to 
  174.       both Diff mode and AlphaVOODOO). 
  175.     • NOTE: Due to a crashing bug in Alpha, if an error is 
  176.       returned from a call to VOODOO while Alpha is in the 
  177.       background (switched either manually or from using the 
  178.       “With Dialog” menu option), an alert dialog will not be 
  179.       displayed.  As much of the message as possible will be 
  180.       displayed in the status bar, instead.
  181.       
  182.          
  183. ###################################################################
  184. 1.0.0b5     December 22, 1997
  185. ###################################################################
  186.  
  187.     • Further modernizations for Vince Darley's Alpha 7.  NOTE: 
  188.       As of this version, AlphaVOODOO is incompatible with Alpha 
  189.       6.5.x. Please contact me, supplying a note from your 
  190.       mother, if you are unable/unwilling to migrate to Alpha 7.
  191.     • Support for the new «event compcomp» compare AE from 
  192.       VOODOO. As of VOODOO 1.8.1b6, the old “DoScript” interface 
  193.       is still used, unless Alpha's creator is changed from 
  194.       'ALFA'.  Either way, the new "diffMode.tcl" is exploited.   
  195.     • Interim patch file "coreFixes+.tcl" that fixes the broken 
  196.       Alpha proc specToPathName.  If you have the December 20, 
  197.       1997 release of Alpha 7 or later (how 'bout some real 
  198.       version numbers, Vince?), this file is not needed, as both 
  199.       it and "aevt.tcl" are in the System code.
  200.     • The code in "diff+.tcl" and "appleEvents+.tcl" has been 
  201.       incorporated in Alpha's core code.  These files may be (and 
  202.       should be) safely removed from Alpha's PREFS folder.
  203.  
  204. ###################################################################
  205. 1.0.0b4     September 5, 1997
  206. ###################################################################
  207.  
  208.     • Installer now compliant with Vince Darley's new Tcl structure.  
  209.       Still works on old systems, too.
  210.     • Project naming and selection now more flexible.
  211.     • All files in fileset now stored and fetched with VOODOO, rather 
  212.       than just TEXT files.
  213.     • Nice display of “Add” and “Locking Status” operations.  When 
  214.       VOODOO's AppleEvent model supports it, “Store” and “Fetch” will 
  215.       generate reports too.
  216.  
  217. ###################################################################
  218. 1.0.0b3     August 10, 1997
  219. ###################################################################
  220.  
  221.     • Multiple VOODOO projects now supported, with easy menu 
  222.       selection.
  223.     • Redesigned settings dialog.
  224.     • Menu redesign; renamed some items and properly disable items 
  225.       when appropriate.
  226.     • Changed key bindings to (the somewhat more cumbersome) 
  227.       <command><shift><control>.  The new bindings don't conflict 
  228.       with any other modes, so far as I know.
  229.     • Improved display of locking-status and add results
  230.     • More robust AppleEvent parsing and handling.
  231.     • More comprehensive and robust error catching.
  232.     • “Log On” and “Log Off” renamed to “Connect” and 
  233.       “Disconnect” at Christoph's suggestion.
  234.  
  235. ###################################################################
  236. 1.0.0b2     July 15, 1997
  237. ###################################################################
  238.  
  239.     • Many error conditions eliminated or handled more gracefully.
  240.     • No longer logs on automatically to select filters.
  241.     • “Project Settings…” dialog sizes itself to the main screen.
  242.     • Filters applied prior to each pertinant action, rather than
  243.       only when changed (the old way meant that the variant filters
  244.       assiged in Alpha might be ignored).
  245.     • Much code commenting.
  246.     • Improved log-in status check.
  247.     • Most dialogs eliminated. User requested dialogs are now handled
  248.       entirely by VOODOO.
  249.     • VOODOO's reply from 'compare' events is now handled properly.
  250.     • Only currently open windows are refreshed after a fileset fetch.
  251.       Remaining files in fileset are fetched, but not opened.
  252.     • Big VOODOO menu icon eliminated.
  253.     
  254. ###################################################################
  255. 1.0.0b1     July 1, 1997
  256. ###################################################################
  257.  
  258.     Original
  259.     
  260.